home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / oil103.zip / BBSNOTES.DOC < prev    next >
Text File  |  1990-12-10  |  15KB  |  348 lines
  1. This document is effective 12/10/90
  2. BBSNOTES
  3.  
  4.  
  5.                  BBS Onliner Interface  version 1.20
  6.                   Copyright (C) 1990 Andrew J. Mead
  7.                          All Rights Reserved.
  8.  
  9.                   Contact:
  10.                        Andrew J. Mead
  11.                        POB 1155
  12.                        Chapel Hill, NC 27514-1155.
  13.                                    or
  14.                        #98 @9968 WWIVnet
  15.                        1:151/223 FidoNet
  16.  
  17.                    Sections (in order of appearance)
  18.  
  19.      General info                -  what this file is
  20.  
  21.      Command Line Directives     -  what options to use
  22.                                     /a Again? mode switch
  23.                                     /n Name switch
  24.                                     /q Quiet mode switch
  25.                                     /x Hall of Fame Limiting switch
  26.                                     /y Hall of Fame Redirection switch
  27.                                     /z Time Limit switch
  28.                                     /i IRQ/PortAddress Customization switch
  29.                                     /l Force Local Mode switch
  30.                                     /c Communication Port Override switch
  31.                                     /b Locked Baud Rate RTS/CTS switch
  32.                                     /k Carrier Detect Override switch
  33.  
  34.      SysOp Control               -  who's playing this game anyway
  35.                                     Current User Line
  36.                                     F-10 SysOp Abort Key
  37.                                     F-9 Line Noise Disconnect Key
  38.  
  39.      Specific BBS Installation
  40.  
  41.      2 A.M. BBS Notes            -  /2  Jumper.Dat installation
  42.      Auntie BBS Notes            -  /7  Auntie.Sys installation
  43.      Force, GAP Notes            -  /S  Door.Sys (long) installation
  44.      Forum Notes                 -  /F  UserInfo.Txt installation
  45.      Genesis Notes               -  /G  CallInfo.BBS installation
  46.      GT, DoorWay Notes           -  /D  Door.Sys (short) installation
  47.      ModuleX Notes               -  /M  Number.Txt installation
  48.      Opus-CBCS 1.13 Notes        -  /3  LastUser.BBS installation
  49.      Opus-CBCS 1.14 Notes        -  /O  LastUsXX.Dat installation
  50.      PCBoard 12.x Notes          -  /1  PCBoard.Sys installation
  51.      PCBoard 14.x Notes          -  /P  PCBoard.Sys installation
  52.      Phoenix Notes               -  /H  Info.BBS installation
  53.      RyBBS Notes                 -  /5  CurrUser.BBS installation
  54.      Sapphire Notes              -  /8  Sapphire.Dat installation
  55.      Search Light Notes          -  /9  Search Light installation
  56.      Spitfire Notes              -  /6  SFDoors.Dat installation
  57.      WildCat Notes               -  /W  CallInfo.BBS installation
  58.      WWIV Notes                  -  /4  Chain.Txt installation
  59.  
  60.      DoorInfo Notes              -  /R# DorInfo#.Def Installation
  61.                                     EIS-PC, FoReM, OLEcom, QuickBBS,
  62.                                     RBBS, Remote Access, TAG, TP-Board
  63.  
  64.  
  65.                            -  General Info  -
  66.  
  67.    This file includes specific notes and examples for most BBS systems
  68.    that this game runs under.  A few basic recomendations:
  69.  
  70.  
  71.                       -  Command Line Directives  -
  72.  
  73.    /a will allow players to play multiple games at one time.  If they have
  74.       more than x minutes left (/a:x), they will be asked if they want to
  75.       play again.  This option carries no recommendation.
  76.      -NOTE: This option does not work with all games (i.e Galactic Empires).
  77.  
  78.    /n this switch is only necessary for use with the /9 SearchLight switch
  79.       or other BBS systems that run the game with command line directives
  80.       instead of using drop files.  It also can be used if you run the
  81.       game locally from DOS.
  82.  
  83.    /q will keep the game from beeping on the host computer.  This enables
  84.       the SysOp to get a good nights sleep.
  85.  
  86.    /x will limit the number of times a player's name will appear on the
  87.       Monthly Hall of Fame.  I recommend /x:2.  This keeps one or two
  88.       good avid players from monopolizing the Hall of Fame.
  89.      -NOTE: This option does not work with all games.
  90.  
  91.    /y I heavily recommend using the text Hall of Fames as bulletins and
  92.       such.  The BBSs in this area that make these files available for the
  93.       users to see tend to have about 5 to 10 times as many players as the
  94.       BBSs that don't.  The ability to look at the top 10 as well as see
  95.       last months top three, and the all time high score tends to highten
  96.       the sense of competition.
  97.      -NOTE: This option is not applicable to all games.
  98.  
  99.    /z sets a maximum time limit.  Normally the game will allow the player
  100.       as much time as he has left to play.  This allows the SysOp to
  101.       encourage players not to fall asleep during games.
  102.  
  103.       The game will execute an inactivity time-out at approximately 2
  104.       minutes.  It will beep at the halfway point and then again when
  105.       it returns control to the BBS.
  106.  
  107.    The game will auto-detect local play, so you can safely play the same
  108.    door locally that the remote users play.
  109.  
  110.    /i allows for customization of your serial communications.  If you are
  111.       using a PS/2 on Com3 or above, or if you are using any non-standard
  112.       IRQ/port address set-up, this option will allow you to get the game
  113.       playing.  This option will not interfere with the game auto-detecting
  114.       local play.  This option (or the /c or /l options) should not be used
  115.       unless absolutely necessary.
  116.  
  117.    NOTE : If you think the game is being forced into local play, check the
  118.    following.  If a remote user is playing the game, the bottom line of the
  119.    host computer will say 'Current User : User's Name or Alias here'.  If
  120.    the line is there, then the game is not locked into local mode.  In local
  121.    mode, the game never displays the 'Current User' line.
  122.  
  123.    /b - Locked BAUD Rate : These programs use RTS handshaking.  If you are
  124.    using a modem with the baud rate locked, then you will want to use this
  125.    switch.  '/B' implements RTS/CTS handshaking, and prevents the game from
  126.    overrunning the modems internal buffer.
  127.  
  128.    /k turns of the games carrier detect routines.  This option is a 'last
  129.        resort' option.  If your modem does not properly maintain a Carrier
  130.        Detect' signal, the game will automatically abort.  This option
  131.        supresses this activity.  If the user does drop carrier, the game
  132.        will still do an inactivity timeout after 2 minutes.  If you are
  133.        forced to use this option, you probably are having hardware problems
  134.        with the modem or RS-232 connector (bad pin or broken wire).
  135.  
  136.  
  137.                            -  SysOp Control  -
  138.  
  139.    Current User Line - The bottom line (line 25) on the BBSs monitor will
  140.        display the name of the player currently logged on.  This will not
  141.        display if the game is being played locally.
  142.  
  143.    F-10 - SysOp abort.  Pressing this key on the host keyboard will abort
  144.        the game in progress, and return control to the batch file, or BBS.
  145.        The user will be notified that the SysOp has terminated the session.
  146.  
  147.    F-9 - Line Noise.  Pressing this key on the host keyboard will simulate
  148.        line noise, then hang up the phone.  It will appear to the user as
  149.        if the connection was trashed.
  150.  
  151.  
  152.                           -  2 A.M. BBS Notes  -
  153.  
  154.    - The /2 option reads a 'Jumper.Dat' file.  For actual installation,
  155.      follow the WWIV example.
  156.  
  157.  
  158.                           -  Auntie BBS Notes  -
  159.  
  160.    - This option is currently in the BETA stage.
  161.    - The /7 option reads a 'Auntie.Sys' file.  You will need to include the
  162.      /c or /i directive with this set-up.  Auntie.Sys does not tell which
  163.      communications port is being used.
  164.    For actual installation,
  165.      follow the WWIV example.  If you have documentation on this file, or
  166.      possibly other files that Auntie BBS creates, please let me know.
  167.  
  168.  
  169.                           -  Force, Gap Notes  -
  170.  
  171.    - The /S option reads a 'Door.Sys' file.  This is the new proposed
  172.      standard for doors.  This format is currently used by Force and GAP.
  173.      For actual installation, follow the WWIV example.
  174.  
  175.  
  176.                              -  Forum Notes  -
  177.  
  178.    - The /F option reads a 'UserInfo.Txt' file.  For actual installation,
  179.      follow the WWIV example.
  180.  
  181.  
  182.                             -  Genesis Notes  -
  183.  
  184.    - The /G option does not currently work.  I do not have sufficient
  185.      information on Genesis' CallInfo.BBS.  It seems to match WildCat's
  186.      upto line 28.  Line 29 should contain communication port information.
  187.      If it does, use the /W directive instead.  I would really appreciate
  188.      some more complete documentation on Genesis.
  189.  
  190.  
  191.                           -  GT, DoorWay Notes  -
  192.  
  193.    - The /D option reads a 'Door.Sys' file.  This is the same Door.Sys that
  194.      is used by Marshall Dudley's DoorWay to Unlimited Doors Program.
  195.      For actual installation, follow the WWIV example.
  196.  
  197.  
  198.                             -  ModuleX Notes  -
  199.  
  200.    - The /M option reads a 'Number.Txt' file.  For actual installation,
  201.      follow the WWIV example.
  202.  
  203.  
  204.                          -  OPUS-CBCS 1.13 Notes  -
  205.  
  206.    - This option does not currently work.
  207.    - The /3 option reads a 'LastUser.BBS' file.  For actual installation,
  208.      follow the WWIV example.  If you have documentation on this file,
  209.      please let me know.
  210.  
  211.  
  212.                          -  OPUS-CBCS 1.14 Notes  -
  213.  
  214.    - The /OXX option reads a 'LastUsXX.Dat' file.  The 'XX' is the OPUS
  215.      task number; if it is absent the program will attempt to read a file
  216.      called 'LastUser.Dat'.  an example with a task number (hexadecimal)
  217.      of 'e' would be
  218.  
  219.      madness /o0e:c:\opus\   ...
  220.  
  221.      the c:\opus\ tells it to look for 'LastUs0E.Dat' in the C:\OPUS\
  222.      directory.  The '...' is the other command line options (check the
  223.      WWIV example for a more thorough example).
  224.  
  225.  
  226.                           -  PCBoard 12.x Notes  -
  227.  
  228.    - This option is currently in the BETA stage..
  229.    - The /1 option reads a 'PCBoard.Sys' file.  For actual installation,
  230.      follow the WWIV example.  If you have documentation on this file,
  231.      please send it to me.
  232.  
  233.  
  234.                           -  PCBoard 14.x Notes  -
  235.  
  236.    - The /P option reads a 'PCBoard.Sys' file.  For actual installation,
  237.      follow the WWIV example.
  238.  
  239.  
  240.                             -  Phoenix Notes  -
  241.  
  242.    - The /H option reads a 'Info.BBS' file.  For actual installation,
  243.      follow the WWIV example.
  244.  
  245.  
  246.                              -  RyBBS Notes  -
  247.  
  248.    - The /5 option reads a 'CurrUser.BBS' file.  For actual installation,
  249.      follow the WWIV example.
  250.  
  251.  
  252.                             -  Sapphire Notes  -
  253.  
  254.    - This option does not currently work.
  255.    - The /8 option reads a 'Sapphire.Dat' file.  For actual installation,
  256.      follow the WWIV example.  If you have documentation on this file, or
  257.      possibly other files that Sapphire BBS creates, please let me know.
  258.  
  259.  
  260.                           -  Search Light Notes  -
  261.  
  262.    - The /9 option is the reverse of the rest of these BBS switches. Since
  263.      the program is being run directly by SLBBS instead of from a batch file,
  264.      the current directory is the same as the BBS's directory.  /9 will tell
  265.      the game to get the path from the command line.
  266.  
  267.                       c:\slbbs\games\stars\starsbbs /9
  268.  
  269.      This will tell the game to get 'c:\slbbs\games\stars\' from memory.
  270.      You will need to pass more information to make the game run.  I have
  271.      added a /n switch to read the users name.  You should use the %U switch
  272.      so that SearchLight passes the complete name like Andy_Mead.  It
  273.      should look something like /n:%U or /n%U.  The next switch you should
  274.      use is the /z directive to get the user's time remaining.  I believe
  275.      the SL switch is %M, so you should have /z:%M or optionally you can
  276.      set a specific time limit (i.e. /z:20).  The final piece of information
  277.      need is communication port.  My games use /c and SL uses %P.  Therefore
  278.      /c:%P should fit the bill.  A final example (check elsewhere for
  279.      descriptions of /a, /q, and /y) would be
  280.  
  281.   c:\slbbs\games\mad\madness /9 /n:%U /c:%P /z:%M /a:15 /y:c:\slbbs\text\ /q
  282.  
  283.      The spaces between switches is mandatory.
  284.  
  285.  
  286.                            -  Spitfire Notes  -
  287.  
  288.    - The /6 option reads a 'SFDoors.Dat' file.  For actual installation,
  289.      follow the WWIV example.
  290.  
  291.  
  292.                             -  WildCat Notes  -
  293.  
  294.    - use the /y command to rename the text hall of fame for your bulletins
  295.      menu.  /y:c:\wildcat\bull34.bbs will rename the Hall of Fame 'Bull34.BBS'
  296.      and place it in the c:\wildcat directory.
  297.  
  298.  
  299.                             -  WWIV Notes  -
  300.  
  301.    - sample WWIV installation (using Star Traders - starsbbs.exe)
  302.      WWIV,chain.txt directory  - C:\WWIV
  303.      batch file                - stars.bat
  304.      stars.bat directory       - C:\WWIV\GAMES
  305.      starsbbs.exe directory    - C:\WWIV\GAMES\STARS
  306.      hall of fames directory   - C:\WWIV\GFILES\HOFSDIR
  307.  
  308.      stars.bat listing
  309.        echo off
  310.        cd c:\wwiv\games\stars
  311.        starsbbs /4:c:\wwiv\ /q /x:2 /z:20 /y:c:\wwiv\gfiles\hofsdir\
  312.        cd c:\wwiv
  313.  
  314.      chainedit setting
  315.        file - c:\wwiv\games\stars.bat
  316.        dos interrupts - off, this game handles it's own communications
  317.        shrink - doesn't matter - recommend NO
  318.        ansi - required
  319.        allow 300 bps users - recommend NO
  320.  
  321.    - If you are NOT using WWIV then substitute your BBSs switch for '/4'.
  322.  
  323.    - In WWIV mode, the current user line will also display user's
  324.      number and real name.
  325.  
  326.  
  327.                           -  DoorInfo Notes  -
  328.  
  329.    - EIS-PC, FoReM, Professional OLEcom, QuickBBS, RBBS, Remote Access,
  330.      TAG, and TP-Board.
  331.    - If you use RBBS (or another DorInfo generating BBS), you will need
  332.      to let the program know what node the program is on.  If you use
  333.      /R by itself, the program will look for a file called DoorInfo.Def.
  334.      /R1 will look for DorInfo1.Def, /R2 will look for DorInfo2.Def, etc...
  335.  
  336.      A sample command line for node 1 (using OilField.exe) would be
  337.      oilfield /r1:c:\rbbs\ /x:2 /z:35 /y:c:\rbbs\bulletn\ /q /a:25
  338.  
  339.      where the program looks for DorInfo1.Def in c:\rbbs and when the
  340.      game is over it places OilHOF.Txt in c:\rbbs\bulletn
  341.  
  342.  
  343.                          BBS Onliner Interface
  344.         Copyright (C) 1990 Andrew J. Mead - All Rights Reserved.
  345.               The Mad Programmer - Brown & Mead Consulting
  346.                   POB 1155 Chapel Hill, NC 27514-1155
  347.  
  348. END BBSNOTES.DOC